Skip to main content

Double Open Server

DOS

The DOS scanner wrapper is a client for the scanner API implemented as part of the Double Open Server project at https://github.com/doubleopen-project/dos. The server runs ScanCode in the backend and stores / reuses scan results on a per-file basis and thus uses its own scan storage.

Configuration​

Example​

{
  "DOS": {
    "options": {
      "url": null,
      "timeout": null,
      "pollInterval": 5,
      "fetchConcluded": false,
      "frontendUrl": "http://localhost:3000",
      "writeToStorage": true
    },
    "secrets": {
      "token": null
    }
  }
}

Options​

url​

STRING Required

The URL where the DOS backend is running.

token​

SECRET Required

The secret token to use with the DOS backend.

timeout​

LONG

The timeout for communicating with the DOS backend, in seconds.

pollInterval​

LONG Default

Interval (in seconds) to use for polling scanjob status from DOS API.

fetchConcluded​

BOOLEAN Default

Use license conclusions as detected licenses when they exist?

frontendUrl​

STRING Default

The URL where the DOS / package curation front-end is running.

writeToStorage​

BOOLEAN Default

Whether to write scan results to the storage.